
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>bent_plume_model.Particle.track &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="bent_plume_model.Particle.update" href="bent_plume_model.Particle.update.html" />
    <link rel="prev" title="bent_plume_model.Particle.run_sbm" href="bent_plume_model.Particle.run_sbm.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="bent-plume-model-particle-track">
<h1>bent_plume_model.Particle.track<a class="headerlink" href="#bent-plume-model-particle-track" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="bent_plume_model.Particle.track">
<code class="sig-prename descclassname">Particle.</code><code class="sig-name descname">track</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">t_p</em>, <em class="sig-param">X_cl</em>, <em class="sig-param">X_p</em>, <em class="sig-param">q_local</em>, <em class="sig-param">Ainv=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/bent_plume_model.html#Particle.track"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bent_plume_model.Particle.track" title="Permalink to this definition">¶</a></dt>
<dd><p>Track the particle in the Lagragian plume model</p>
<p>Track the location of the particle within a Lagrangian plume model
element and stop the integration when the particle exits the plume.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>t_p</strong><span class="classifier">float</span></dt><dd><p>Time since the particle was released (s)</p>
</dd>
<dt><strong>X_cl</strong><span class="classifier">ndarray</span></dt><dd><p>Array of Cartesian coordinates (x,y,z) for the plume centerline
(m).</p>
</dd>
<dt><strong>X_p</strong><span class="classifier">ndarray</span></dt><dd><p>Array of local plume coordinates (l,n,m) for the current
particle position (m)().  This method converts these coordinates,
which are solved by the bent plume model state space solution, to
Cartesian coordinates.</p>
</dd>
<dt><strong>q_local</strong><span class="classifier"><cite>LagElement</cite> object</span></dt><dd><p>Object that translates the bent plume model state space <cite>t</cite> and
<cite>q</cite> into the comprehensive list of derived variables.</p>
</dd>
<dt><strong>Ainv</strong><span class="classifier">ndarray, default = None</span></dt><dd><p>Coordinate transformation matrix from the local plume coordinates
(l,n,m) to Cartesian coordinates (x,y,z).  If <cite>Ainv</cite> is known, it
can be passed to this function; otherwise, this function can
solve for <cite>Ainv</cite> using q_local.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>xp</strong><span class="classifier">ndarray</span></dt><dd><p>Array of Cartesian coordinates (x,y,z) for the current particle
position (m).</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/bpm.html">Overview of Bent Plume Model Module</a><ul>
  <li><a href="bent_plume_model.Particle.html">bent_plume_model.Particle</a><ul>
      <li>Previous: <a href="bent_plume_model.Particle.run_sbm.html" title="previous chapter">bent_plume_model.Particle.run_sbm</a></li>
      <li>Next: <a href="bent_plume_model.Particle.update.html" title="next chapter">bent_plume_model.Particle.update</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/bpm/bent_plume_model.Particle.track.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>